thermostat6.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef THERMOSTAT6_H
#define THERMOSTAT6_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"




#define THERMOSTAT6_ADC_RESOLUTION      0x0FFF
#define THERMOSTAT6_VREF_3V3            3.3
#define THERMOSTAT6_VREF_5V             5.0
#define THERMOSTAT6_ADC_NUM_SAMPLES_50  50

#define THERMOSTAT6_SET_DEV_ADDR        0x4D
 // thermostat6_set



#define THERMOSTAT6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.relay = MIKROBUS( mikrobus, MIKROBUS_PWM );
 // thermostat6_map // thermostat6

typedef struct
{
    digital_in_t relay;             
 
    analog_in_t  adc;               
    i2c_master_t i2c;               
 
    uint8_t      slave_address;     
    float        vref;              
 
} thermostat6_t;

typedef struct
{
    pin_name_t an;                  
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t relay;               
 
    analog_in_resolution_t resolution;  
    float                  vref;        
    
    uint32_t               i2c_speed;   
    uint8_t                i2c_address; 
 
} thermostat6_cfg_t;

typedef enum
{
    THERMOSTAT6_OK = 0,
    THERMOSTAT6_ERROR = -1
 
} thermostat6_return_value_t;


void thermostat6_cfg_setup ( thermostat6_cfg_t *cfg );

err_t thermostat6_init ( thermostat6_t *ctx, thermostat6_cfg_t *cfg );

err_t thermostat6_get_adc_v ( thermostat6_t *ctx, float *voltage );

err_t thermostat6_get_adc_v_avg ( thermostat6_t *ctx, float *voltage, uint16_t num_samples );

err_t thermostat6_get_an_pin_v ( thermostat6_t *ctx, float *voltage );

err_t thermostat6_get_an_pin_v_avg ( thermostat6_t *ctx, float *voltage, uint16_t num_samples );

err_t thermostat6_set_vref ( thermostat6_t *ctx, float vref );

uint8_t thermostat6_get_relay_pin ( thermostat6_t *ctx );

float thermostat6_get_temperature ( float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // THERMOSTAT6_H
 // thermostat6
 
// ------------------------------------------------------------------------ END